home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / OSUtils.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  11.2 KB  |  462 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        OSUtils.a
  3. ;
  4. ;    Contains:    OS Utilities Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1985-1997 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__OSUTILS__') = 'UNDEFINED' THEN
  19. __OSUTILS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  25.     include 'MixedMode.a'
  26.     ENDIF
  27. ;   HandToHand and other memory utilties were moved to MacMemory.h 
  28.     IF &TYPE('__MACMEMORY__') = 'UNDEFINED' THEN
  29.     include 'MacMemory.a'
  30.     ENDIF
  31. ;   GetTrapAddress and other trap table utilties were moved to Patches.h 
  32.     IF &TYPE('__PATCHES__') = 'UNDEFINED' THEN
  33.     include 'Patches.a'
  34.     ENDIF
  35. ;   Date and Time utilties were moved to DateTimeUtils.h 
  36.     IF &TYPE('__DATETIMEUTILS__') = 'UNDEFINED' THEN
  37.     include 'DateTimeUtils.a'
  38.     ENDIF
  39.  
  40.  
  41. useFree                            EQU        0
  42. useATalk                        EQU        1
  43. useAsync                        EQU        2
  44. useExtClk                        EQU        3                    ;Externally clocked
  45. useMIDI                            EQU        4
  46.  
  47. false32b                        EQU        0                    ;24 bit addressing error
  48. true32b                            EQU        1                    ;32 bit addressing error
  49.  
  50.                                                             ; result types for RelString Call 
  51. sortsBefore                        EQU        -1                    ;first string < second string
  52. sortsEqual                        EQU        0                    ;first string = second string
  53. sortsAfter                        EQU        1                    ;first string > second string
  54.  
  55. dummyType                        EQU        0
  56. vType                            EQU        1
  57. ioQType                            EQU        2
  58. drvQType                        EQU        3
  59. evType                            EQU        4
  60. fsQType                            EQU        5
  61. sIQType                            EQU        6
  62. dtQType                            EQU        7
  63. nmType                            EQU        8
  64. ; typedef SignedByte                     QTypes
  65.  
  66. SysParmType                RECORD 0
  67. valid                     ds.b    1                ; offset: $0 (0)
  68. aTalkA                     ds.b    1                ; offset: $1 (1)
  69. aTalkB                     ds.b    1                ; offset: $2 (2)
  70. config                     ds.b    1                ; offset: $3 (3)
  71. portA                     ds.w    1                ; offset: $4 (4)
  72. portB                     ds.w    1                ; offset: $6 (6)
  73. alarm                     ds.l    1                ; offset: $8 (8)
  74. font                     ds.w    1                ; offset: $C (12)
  75. kbdPrint                 ds.w    1                ; offset: $E (14)
  76. volClik                     ds.w    1                ; offset: $10 (16)
  77. misc                     ds.w    1                ; offset: $12 (18)
  78. sizeof                     EQU *                    ; size:   $14 (20)
  79.                         ENDR
  80. ; typedef struct SysParmType *            SysPPtr
  81.  
  82. QElem                    RECORD 0
  83. qLink                     ds.l    1                ; offset: $0 (0)
  84. qType                     ds.w    1                ; offset: $4 (4)
  85. qData                     ds.w    1                ; offset: $6 (6) <-- really an array of length one
  86. sizeof                     EQU *                    ; size:   $8 (8)
  87.                         ENDR
  88. ; typedef struct QElem *                QElemPtr
  89.  
  90. QHdr                    RECORD 0
  91. qFlags                     ds.w    1                ; offset: $0 (0)
  92. qHead                     ds.l    1                ; offset: $2 (2)
  93. qTail                     ds.l    1                ; offset: $6 (6)
  94. sizeof                     EQU *                    ; size:   $A (10)
  95.                         ENDR
  96. ; typedef struct QHdr *                    QHdrPtr
  97.  
  98.  
  99.  
  100. DeferredTask            RECORD 0
  101. qLink                     ds.l    1                ; offset: $0 (0)
  102. qType                     ds.w    1                ; offset: $4 (4)
  103. dtFlags                     ds.w    1                ; offset: $6 (6)
  104. dtAddr                     ds.l    1                ; offset: $8 (8)
  105. dtParam                     ds.l    1                ; offset: $C (12)
  106. dtReserved                 ds.l    1                ; offset: $10 (16)
  107. sizeof                     EQU *                    ; size:   $14 (20)
  108.                         ENDR
  109. ; typedef struct DeferredTask *            DeferredTaskPtr
  110.  
  111. MachineLocation            RECORD 0
  112. latitude                 ds.l    1                ; offset: $0 (0)
  113. longitude                 ds.l    1                ; offset: $4 (4)
  114. dlsDelta                 ds.b    1                ; offset: $8 (8)        ;  signed byte; daylight savings delta 
  115.                          ORG 8
  116. gmtDelta                 ds.l    1                ; offset: $8 (8)        ;  use low 24-bits only 
  117. sizeof                     EQU *                    ; size:   $C (12)
  118.                         ENDR
  119.  
  120. ;
  121. ; pascal Boolean IsMetric(void )
  122. ;
  123.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  124.         Macro
  125.         _IsMetric
  126.             move.w              #$0004,-(sp)
  127.             dc.w                $A9ED
  128.         EndM
  129.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  130.         IMPORT_CFM_FUNCTION IsMetric
  131.     ENDIF
  132.  
  133. ;
  134. ; pascal SysPPtr GetSysPPtr(void )
  135. ;
  136.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  137.         Macro
  138.         _GetSysPPtr           &dest=(sp)
  139.             move.l            #$000001F8,&dest
  140.         EndM
  141.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  142.         IMPORT_CFM_FUNCTION GetSysPPtr
  143.     ENDIF
  144.  
  145.  
  146. ; 
  147. ;    NOTE: SysBeep() has been moved to Sound.h.  
  148. ;          We could not automatically #include Sound.h in this file
  149. ;          because Sound.h indirectly #include's OSUtils.h which
  150. ;          would make a circular include.
  151. ;
  152.  
  153. ;
  154. ; pascal OSErr DTInstall(DeferredTaskPtr dtTaskPtr)
  155. ;
  156.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  157.         ; parameters:
  158.         ;    dtTaskPtr       => A0
  159.         ; returns:
  160.         ;    OSErr           <= D0
  161.         _DTInstall:    OPWORD    $A082
  162.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  163.         IMPORT_CFM_FUNCTION DTInstall
  164.     ENDIF
  165.  
  166.  
  167.  
  168. ;
  169. ; pascal SInt8 GetMMUMode(void)
  170. ;
  171.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  172.         Macro
  173.         _GetMMUMode           &dest=(sp)
  174.             move.b            $0CB2,&dest
  175.         EndM
  176.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  177.         IMPORT_CFM_FUNCTION GetMMUMode
  178.     ENDIF
  179.  
  180. ;
  181. ; pascal SInt8 SwapMMUMode(SInt8 mode)
  182. ;
  183.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  184.         ; parameters:
  185.         ;    mode            => D0
  186.         ; returns:
  187.         ;    SInt8           <= D0
  188.         _SwapMMUMode:    OPWORD    $A05D
  189.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  190.         IMPORT_CFM_FUNCTION SwapMMUMode
  191.     ENDIF
  192.  
  193. ;
  194. ; pascal void Delay(unsigned long numTicks, unsigned long *finalTicks)
  195. ;
  196.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  197.         _Delay:    OPWORD    $A03B
  198.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  199.         IMPORT_CFM_FUNCTION Delay
  200.     ENDIF
  201.  
  202.  
  203. ;
  204. ; pascal OSErr WriteParam(void )
  205. ;
  206.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  207.         _WriteParam:    OPWORD    $A038
  208.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  209.         IMPORT_CFM_FUNCTION WriteParam
  210.     ENDIF
  211.  
  212. ;
  213. ; pascal void Enqueue(QElemPtr qElement, QHdrPtr qHeader)
  214. ;
  215.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  216.         ; parameters:
  217.         ;    qElement        => A0
  218.         ;    qHeader         => A1
  219.         _Enqueue:    OPWORD    $A96F
  220.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  221.         IMPORT_CFM_FUNCTION Enqueue
  222.     ENDIF
  223.  
  224. ;
  225. ; pascal OSErr Dequeue(QElemPtr qElement, QHdrPtr qHeader)
  226. ;
  227.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  228.         ; parameters:
  229.         ;    qElement        => A0
  230.         ;    qHeader         => A1
  231.         ; returns:
  232.         ;    OSErr           <= D0
  233.         _Dequeue:    OPWORD    $A96E
  234.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  235.         IMPORT_CFM_FUNCTION Dequeue
  236.     ENDIF
  237.  
  238. ;
  239. ; pascal OSErr InitUtil(void )
  240. ;
  241.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  242.         ; returns:
  243.         ;    OSErr           <= D0
  244.         _InitUtil:    OPWORD    $A03F
  245.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  246.         IMPORT_CFM_FUNCTION InitUtil
  247.     ENDIF
  248.  
  249.  
  250.     IF TARGET_CPU_PPC THEN
  251. ;
  252. ; pascal void MakeDataExecutable(void *baseAddress, unsigned long length)
  253. ;
  254.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  255.         IMPORT_CFM_FUNCTION MakeDataExecutable
  256.     ENDIF
  257.  
  258.     ENDIF    ; TARGET_CPU_PPC
  259.     IF TARGET_CPU_68K THEN
  260. ;
  261. ; pascal Boolean SwapInstructionCache(Boolean cacheEnable)
  262. ;
  263.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  264.         Macro
  265.         _SwapInstructionCache
  266.             moveq               #0,D0
  267.             dc.w                $A098
  268.         EndM
  269.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  270.         IMPORT_CFM_FUNCTION SwapInstructionCache
  271.     ENDIF
  272.  
  273. ;
  274. ; pascal void FlushInstructionCache(void )
  275. ;
  276.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  277.         Macro
  278.         _FlushInstructionCache
  279.             moveq               #1,D0
  280.             dc.w                $A098
  281.         EndM
  282.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  283.         IMPORT_CFM_FUNCTION FlushInstructionCache
  284.     ENDIF
  285.  
  286. ;
  287. ; pascal Boolean SwapDataCache(Boolean cacheEnable)
  288. ;
  289.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  290.         Macro
  291.         _SwapDataCache
  292.             moveq               #2,D0
  293.             dc.w                $A098
  294.         EndM
  295.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  296.         IMPORT_CFM_FUNCTION SwapDataCache
  297.     ENDIF
  298.  
  299. ;
  300. ; pascal void FlushDataCache(void )
  301. ;
  302.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  303.         Macro
  304.         _FlushDataCache
  305.             moveq               #3,D0
  306.             dc.w                $A098
  307.         EndM
  308.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  309.         IMPORT_CFM_FUNCTION FlushDataCache
  310.     ENDIF
  311.  
  312. ;
  313. ; pascal void FlushCodeCache(void )
  314. ;
  315.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  316.         _FlushCodeCache:    OPWORD    $A0BD
  317.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  318.         IMPORT_CFM_FUNCTION FlushCodeCache
  319.     ENDIF
  320.  
  321. ;
  322. ; pascal OSErr FlushCodeCacheRange(void *address, unsigned long count)
  323. ;
  324.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  325.         ; parameters:
  326.         ;    address         => A0
  327.         ;    count           => A1
  328.         ; returns:
  329.         ;    OSErr           <= D0
  330.         Macro
  331.         _FlushCodeCacheRange
  332.             moveq               #9,D0
  333.             dc.w                $A098
  334.         EndM
  335.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  336.         IMPORT_CFM_FUNCTION FlushCodeCacheRange
  337.     ENDIF
  338.  
  339. ;
  340. ; pascal void FlushExternalCache(void )
  341. ;
  342.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  343.         Macro
  344.         _FlushExternalCache
  345.             moveq               #6,D0
  346.             dc.w                $A098
  347.         EndM
  348.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  349.         IMPORT_CFM_FUNCTION FlushExternalCache
  350.     ENDIF
  351.  
  352.     ENDIF    ; TARGET_CPU_68K
  353. ;
  354. ; pascal void ReadLocation(MachineLocation *loc)
  355. ;
  356.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  357.         ; parameters:
  358.         ;    loc             => A0
  359.         Macro
  360.         _ReadLocation
  361.             move.l              #$000C00E4,D0
  362.             dc.w                $A051
  363.         EndM
  364.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  365.         IMPORT_CFM_FUNCTION ReadLocation
  366.     ENDIF
  367.  
  368. ;
  369. ; pascal void WriteLocation(const MachineLocation *loc)
  370. ;
  371.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  372.         ; parameters:
  373.         ;    loc             => A0
  374.         Macro
  375.         _WriteLocation
  376.             move.l              #$000C00E4,D0
  377.             dc.w                $A052
  378.         EndM
  379.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  380.         IMPORT_CFM_FUNCTION WriteLocation
  381.     ENDIF
  382.  
  383.  
  384.  
  385.     IF OLDROUTINENAMES THEN
  386.     ENDIF    ; OLDROUTINENAMES
  387. ; 
  388. ;    NOTE: SysEnvirons is obsolete.  You should be using Gestalt.
  389. ;
  390.  
  391. ;  Environs Equates 
  392.  
  393. curSysEnvVers                    EQU        2                    ;Updated to equal latest SysEnvirons version
  394. SysEnvRec                RECORD 0
  395. environsVersion             ds.w    1                ; offset: $0 (0)
  396. machineType                 ds.w    1                ; offset: $2 (2)
  397. systemVersion             ds.w    1                ; offset: $4 (4)
  398. processor                 ds.w    1                ; offset: $6 (6)
  399. hasFPU                     ds.b    1                ; offset: $8 (8)
  400. hasColorQD                 ds.b    1                ; offset: $9 (9)
  401. keyBoardType             ds.w    1                ; offset: $A (10)
  402. atDrvrVersNum             ds.w    1                ; offset: $C (12)
  403. sysVRefNum                 ds.w    1                ; offset: $E (14)
  404. sizeof                     EQU *                    ; size:   $10 (16)
  405.                         ENDR
  406.  
  407.                                                             ; Machine Types 
  408. envMac                            EQU        -1
  409. envXL                            EQU        -2
  410. envMachUnknown                    EQU        0
  411. env512KE                        EQU        1
  412. envMacPlus                        EQU        2
  413. envSE                            EQU        3
  414. envMacII                        EQU        4
  415. envMacIIx                        EQU        5
  416. envMacIIcx                        EQU        6
  417. envSE30                            EQU        7
  418. envPortable                        EQU        8
  419. envMacIIci                        EQU        9
  420. envMacIIfx                        EQU        11
  421.  
  422.                                                             ; CPU types 
  423. envCPUUnknown                    EQU        0
  424. env68000                        EQU        1
  425. env68010                        EQU        2
  426. env68020                        EQU        3
  427. env68030                        EQU        4
  428. env68040                        EQU        5
  429.  
  430.                                                             ; Keyboard types 
  431. envUnknownKbd                    EQU        0
  432. envMacKbd                        EQU        1
  433. envMacAndPad                    EQU        2
  434. envMacPlusKbd                    EQU        3
  435. envAExtendKbd                    EQU        4
  436. envStandADBKbd                    EQU        5
  437. envPrtblADBKbd                    EQU        6
  438. envPrtblISOKbd                    EQU        7
  439. envStdISOADBKbd                    EQU        8
  440. envExtISOADBKbd                    EQU        9
  441. ;
  442. ; pascal OSErr SysEnvirons(short versionRequested, SysEnvRec *theWorld)
  443. ;
  444.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  445.         ; parameters:
  446.         ;    versionRequetheWorld=> D0
  447.         ;    theWorld        => A0
  448.         ; returns:
  449.         ;    OSErr           <= D0
  450.         _SysEnvirons:    OPWORD    $A090
  451.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  452.         IMPORT_CFM_FUNCTION SysEnvirons
  453.     ENDIF
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.     ENDIF ; __OSUTILS__ 
  461.  
  462.